dxp-ux

(0 reviews)

GET logicalResourceById (TMF639)

1.This is implemented for PA Market.

2.This is to retrieve the customer subscription profile by passing IMSI number as input.

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/logicalResource/{id}

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (PA) identifying the business unit.	Y
id	string	Identifier of the Resource. Note: id should contain only digits	Y

Query PARAMS

name	type	description	required
@type	string	Type of logical resource. Possible Value : IMSI	Y

Headers

name	type	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y for Business

Data Model - Response

field name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
id	string	Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.	Y
href	string	The URI for the object itself.	N
name	string	A string used to give a name to the resource.	Y
resourceStatus	string	A resource status type. Tracks the resource status of the resource, Possible Values: standby, active, alarm, available, reserved, suspended, unknown.	Y
resourceCharacteristic[]	Array	A list of characteristics. Describes a given characteristic of an object or entity through a name/value pair.	Y
resourceCharacteristic[].name	string	Name of the characteristic	Y
resourceCharacteristic[].value	any	Value of the characteristic	Y
resourceRelationship[]	Array	A list of resource relationships	Y
resourceRelationship[].relationshipType	string	Type of the resource relationship	Y
resourceRelationship[].resource	object	A resource to be created defined by value or existing defined by reference.	Y
resourceRelationship[].resource.id	string	Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type.	Y
resourceRelationship[].resource.name	string	A string used to give a name to the resource	Y
@type	string	When sub-classing, this defines the sub-class Extensible name	Y

resourceCharacteristic subResource - dataModel

resource characteristic name	type	description	required(mandatory-Y, optional-N, Not applicable- N/A)	examples
pin1	string	This is PIN1 value	N	{ "name": "pin1", "value": "1111" }
pin2	string	This is PIN2 value	N	{ "name": "pin2", "value": "6021" }
puk1	string	This is PUK1 value	N	{ "name": "puk1", "value": "78617534" }
puk2	string	This is PUK2 value	N	{ "name": "puk2", "value": "12962790" }
prepaidInd	string	Is to show the service Prepaid or not(Y or N)	Y	{ "name": "prepaidInd", "value": "N" }
sim-provid	string	This is SIM-PROVID value	N	{ "name": "sim-provid", "value": "05.06" }
serviceCategory	string	This is service category value.	N	{ "name": "serviceCategory", "value": "Black List" }

resourceRelationship subResource - dataModel

resourceRelationship name	type	description	required(mandatory-Y, optional-N, Not applicable- N/A)	examples
MSISDN	string	Service Number	Y	{ "relationshipType": "reliesOn", "resource": { "id": "66770996", "name": "MSISDN" } }
SIM	string	Subscriber Identity Module	N	{ "relationshipType": "reliesOn", "resource": { "id": "89507010000023865393", "name": "SIM" } }

Key considerations

Please find the response in the following link - GET LogicalResourceById - DXP-UX

PA Implementation:

- This is implemented for prepaid and postpaid mobile customers.
- Value for @type Query Parameter should be "IMSI", when input ID is IMSI number.
- Prepaid/Postpaid subscriber can be identified using resourceCharacteristic.value (Y=Prepaid, N=Postpaid) when resourceCharacteristic.name is "prepaidInd".
- Possible values of resourceCharacteristic.value when resourceCharacteristic.name is "serviceCategory":
   - for PREPAID service: Prepaid.
   - for POSTPAID service: Black List, White List, Postpaid B2C, Postpaid B2B.